Documentation

1. Description

The Sitemap XSL component builds the visual structure of your site (see the example below). The component also provides easy navigation through the pages of your site.

The picture below shows an example of a Sitemap:

Please refer to the XSL section for more information about creating XSL renderings.

2. Installation Guide

The XSL Sitemap rendering is distributed as a standard Sitecore package. Thus in order to start using it, you should install the package. Please refer to the ' Installing Modules and Packages ' article if you are not familiar with the standard Sitecore Packager tool.

After the package installation, you will see the XSL sitemap control in the list of XSL renderings.

Thus you will be able to place it on a (sub)layout or tie via placeholder like any usual rendering.

3. User Manual

The Sitemap is an XSL rendering, thus you can work with it like with any other XSL rendering.

The Sitemap XSL rendering is adjusted via several parameters.

The change condition of the sitemap is controlled by the product variable of the  section.

Some of the parameters used for the divider rendering have the default value (path to the image, for instance). You can change the path to the divider image in the .xslt file or replace them on your hard drive (after the package installation, the images will be placed under the Image folder in the root folder of Sitecore installation).

Open the Parameters tab of the rendering (double-click on the rendering) and set properties as described in the example below.

You can also define the properties in the  section in the rendering’s source code.

Valid Parameters:

SMClass

Property value:

The CSS class name for the Sitemap.

SMStyle

Property value:

The style for the Sitemap.

SMTitleClass

Property value:

The Css class name for the Sitemap’s title (Sitecore Home in the picture in the first chapter).

SMTitleStyle

Property value:

The style for the Sitemap’s title.

SMTextClass

Property value:

The Css class name for the Sitemap’s text.

SMTextStyle

Property value:

The style for the Sitemap’s text.

SMTopLevelTextClass

Property value:

The Css class name for the Item’s text in the Sitemap which will be shown in first level hierarchy.

SMTopLevelTextStyle

Property value:

The style for the Sitemap’s top level text.

SMTitleField

Property value:

THe name of the field that contains text to be displayed in the Sitemap's title. The default value is "Title".

SMTextField

Property value:

The name of the field that contains text to be displayed in the Item's title. The default value is "Text".

DividerClass

Property value:

The Css class name for the divider.

Remarks:

THe divider is a text or an image used for separating Sitemap Items.

DividerStyle

Property value:

The style for the divider

Remarks:

The divider is a text or an image used for separating Sitemap Items.

HorizontalDividerImage

Property value:

The name and path to the image file which will be shown as a horizontal divider for the Item.

Remarks:

The default is '/images/smHoriz.gif'

VerticalDividerImage

Property value:

The name and path to the image file which will be shown as a vertical divider for the Item.

Remarks:

The default is '/images/smVertical.gif'

TopDividerImage

Property value:

The name and path to the image file which will be shown as a top divider for the Item.

Remarks:

The default is '/images/smtop.gif'

ItemDividerImage

Property value:

The name and path to the image file which will be shown as an Item divider for the Item.

Remarks:

The default is '/images/smItem.gif'

BottomDividerImage

Property value:

The name and path to the image file which will be shown as a bottom divider for the Item.

Remarks:

The default is '/images/smBottom.gif'

HorizontalDividerText

Property value:

The text which will be shown as a horizontal divider for the Item.

Remarks:

The default is empty. If the field is defined, the HorizontalDividerImage parameter is ignored.

VerticalDividerText

Property value:

THe text which will be shown as a vertical divider for the Item.

Remarks:

The default is empty. If the field is defined, the VerticalDividerImage parameter is ignored.

TopDividerText

Property value:

THe text which will be shown as a top divider for the Item.

Remarks:

THe default is empty. If the field is defined, the TopDividerImage parameter is ignored.

ItemDividerText

Property value:

The text which will be shown as a vertical divider for the Item.

Remarks:

The default is empty. If the field is defined, the ItemDividerImage parameter is ignored.

BottomDividerText

Property value:

The text which will be shown as a bottom divider for the Item.

Remarks:

The default value is empty. If the field is defined, the BottomDividerImage parameter is ignored.